Activity Notification
🛠️ Product Notification from Third-Party
This API is required to send notifications related to Product activities from a third party.
| Field | Value |
|---|---|
| Name | ThirdpartyNotificationAPI |
| URL | http://<domain>/v1/ThirdpartyNotificationAPI |
| Description | Send notification to end user for Product activities from third party |
| Method | POST |
📤 Request
Header
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| Authorization | String | M | Encrypted Token; authentication token for all API calls |
| Content-Type | application/json |
Body
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| productCode | String | M | Unique Product Code identifying the published product |
| type | String | M | 1 – Send for all products; 2 – Send for specific product |
| userRefId | String | M | Trading User ID |
| message | String | M | Notification text (e.g., "User has opted for Investing in EQUITYBasket") |
| msgSubject | String | M | Notification Subject (e.g., "EQUITYBasket Investment") |
Example Request
{
"productCode": "myproductCode",
"type": 2,
"userRefId": "A0001",
"message": "User has opted for Investing in EQUITYBasket",
"msgSubject": "EquityBasket Investment"
}
📄 Response
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| Success | Boolean | M | true – Success, false – Failure |
| Data | String | M | JSON string, details of order |
| Message | String | M | Success/Failure message for the API |
| statusCode | String | M | Application status code |
| traceId | String | M | System generated Code by third-party, used for VAS log purpose |
** 🟢 Example Success Response**
{
"success": true,
"data": null,
"message": "Notification Send Successfully.",
"statusCode": "200",
"traceId": "2d7814b4-3d29-44cd-94f3-969e3db22eed"
}
** 🔴 Example Failure Response**
{
"success": false,
"data": null,
"message": "<respective error message>",
"statusCode": "400",
"traceId": "409dea70-df0d-4909-9321-b4f094f2ecc1"
}